Skip to content

Update readme as per new default staging mode #4801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

niknbr
Copy link

@niknbr niknbr commented Aug 7, 2025

  • PR Description

Update readme as per the new default staging mode #4780

  • Please check if the PR fulfills these requirements
  • Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Tests have been added/updated (see here for the integration test guide)
  • Text is internationalised (see here)
  • If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)
  • Docs have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

@stefanhaller
Copy link
Collaborator

This is a good change, thanks; however, the demo video below no longer quite matches what's described there, so ideally it should be updated too. I'm a little undecided if the text change alone is already worth merging as "still better than before, at least".

@niknbr
Copy link
Author

niknbr commented Aug 8, 2025

@stefanhaller Ah. I missed that. I could raise another PR to assets branch, but it probably won't look the same and be consistent with others.

@stefanhaller
Copy link
Collaborator

but it probably won't look the same and be consistent with others.

I think it will if you follow the instructions in docs/dev/Demo_Recordings.md.

The demo that needs updating seems to be pkg/integration/tests/demo/stage_lines.go. Actually, re-recording that demo with the current version will probably yield the same result as before, because starting a range selection cancels hunk mode. But we don't want that; you could simply delete lines 63-66 to have the demo do what it did before, just with fewer keystrokes. (Which proves my point that changing to hunk mode by default was a good change. 😄)

We might think about extending the demo so that it also shows how to turn off hunk mode and stage individual lines; I'm not sure that's getting too detailed though. Frankly, I'm not very familiar with the demo content and what level of detail we tend to show there, and I don't want to spend time catching up on that right now, so if you are willing to dig into this a bit and figure out what's good, I'm happy to let you make a decision.

@stefanhaller
Copy link
Collaborator

I'll hold off merging this PR for now, because if we decide not to extend that demo, then we will probably want to rename it to something like stage_block_of_changes.go, and that's a change we could include here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants